Skip to main content

ClaimCenter Common API (1.11.0)

APIs for common InsuranceSuite platform objects like activities and notes

Return a schema for a single named business entity

Return a schema for a single named business entity. The schema will contain the definition for the requested business entity as well as other schema definitions it references. (Since 1.7.0)

gw-resourceType: EntitySchema
gw-sinceVersion: 1.7.0
Authorizations:
path Parameters
entityId
required
string
gw-sinceVersion: 1.7.0

The id of the entity whose schema is being requested (Since 1.7.0)

query Parameters
inlineTypelists
boolean
Default: false
gw-sinceVersion: 1.7.0

Whether or not to include all referenced typelist values inline on properties. Defaults to false. (Since 1.7.0)

prettyPrint
boolean
Default: false

Whether or not to pretty-print the returned schema, making it larger but more human readable. Defaults to false.

includeLocalizations
Array of strings
gw-sinceVersion: 1.8.0

A comma-separated list of language codes to include localizations for, or the special code *all to include all languages configured in the application (Since 1.8.0)

Responses

Response samples

Content type
application/json
"string"